/*
*  Copyright (c) 2001 Sun Microsystems, Inc.  All rights
*  reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*  1. Redistributions of source code must retain the above copyright
*  notice, this list of conditions and the following disclaimer.
*
*  2. Redistributions in binary form must reproduce the above copyright
*  notice, this list of conditions and the following disclaimer in
*  the documentation and/or other materials provided with the
*  distribution.
*
*  3. The end-user documentation included with the redistribution,
*  if any, must include the following acknowledgment:
*  "This product includes software developed by the
*  Sun Microsystems, Inc. for Project JXTA."
*  Alternately, this acknowledgment may appear in the software itself,
*  if and wherever such third-party acknowledgments normally appear.
*
*  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA"
*  must not be used to endorse or promote products derived from this
*  software without prior written permission. For written
*  permission, please contact Project JXTA at http://www.jxta.org.
*
*  5. Products derived from this software may not be called "JXTA",
*  nor may "JXTA" appear in their name, without prior written
*  permission of Sun.
*
*  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
*  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*  DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
*  ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
*  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
*  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
*  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
*  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*  SUCH DAMAGE.
*  ====================================================================
*
*  This software consists of voluntary contributions made by many
*  individuals on behalf of Project JXTA.  For more
*  information on Project JXTA, please see
*  <http://www.jxta.org/>.
*
*  This license is based on the BSD license adopted by the Apache Foundation.
*
*  $Id: GroupNode.java,v 1.3 2006/05/17 21:24:01 nano Exp $
*/

package net.jxta.myjxta.util.objectmodel;

import net.jxta.myjxta.util.Group;
import net.jxta.myjxta.util.Resources;
import net.jxta.protocol.PeerGroupAdvertisement;

import javax.swing.*;

/**
 *
 * @version $Id: GroupNode.java,v 1.3 2006/05/17 21:24:01 nano Exp $
 *
 * @author james todd [gonzo at jxta dot org]
 */

public final class GroupNode
    extends JxtaNode {

    /** The category used by this peer */
    public static final String CATEGORY_GROUP = "group";

    /** The image to use to display as a node image */
    public static final ImageIcon groupImage = null;

    /** The peer group that is described by this JxtaNode */
    private Group group = null;

    /**
     * Create a new GroupNode
     *
     * @param group the peer group that this node describes
     */
    public GroupNode(Group group) {
        super(null, group.getId(), group.getName(), CATEGORY_GROUP);
        
        this.group = group;
    }


    /**
     * Get the peer group that this node represents
     *
     * @return the peer group that this node represents
     */
    public Group getGroup() {
        return this.group;
    }

    /**
     * Check whether this group equals the given object.
     * This is true if o is an instance of GroupNode and
     * if the equals method for the two groups wrapped by
     * the two GroupNode returns true.
     *
     * @param o the object to which to compare
     * 
     * @return true if the peer groups represents by the 
     *         two GroupNodes being compared are the same
     */
    public boolean equals(Object o) {
        return (o instanceof GroupNode &&
            this.group.equals(((GroupNode)o).getGroup()));
    }

    /**
     * hash method must be over-ridden if equals() is over-ridden.
     * The Object api says that if two objects evaulate as equal using
     * the equals() method, then their hash codes must be equal.
     * 
     * This hash method ensures that the hash codes reflect the
     * information evaluated by equals.
     *
     * @return hash code for this GroupNode.
     */
    public int hashCode() {
        return this.group.hashCode();
    }
    
    public int compareTo(Object o) {
        int v = 0;
        
        if (o instanceof GroupNode) {
            v = equals(o) ? 0 : toString().compareToIgnoreCase(o.toString());
        } else if (o instanceof PeerNode) {
            v = 1;
        } else if (o instanceof ShareNode) {
            v = -1;
        }
        
        return v;
    }

    /**
     * Return the image to return for this 
     * JxtaNode
     * 
     * @param selected is the node currently selected
     * @param expanded is the node currently expanded
     * @param hasFocus has the node currently keyboard focus
     */
    public ImageIcon getImage(boolean selected, boolean expanded,
        boolean hasFocus) {
        Resources res = Resources.getInstance();
        ImageIcon icon = null;
        
        if (group != null &&
            group.isJoined()) {
            icon = res.getIconResource("TreeTable.PeerGroupJoined");
        } else {
            icon = res.getIconResource("TreeTable.PeerGroup");
        }
        
        return icon;
    }


    /**
     * Return a descriptive string for the group.
     * If we can extract the description of the group, we display it,
     * otherwise an empty string is displayed
     * 
     * @return a description for the group 
     */
    public String getDescription() {
        String desc = null;

        if( group != null) {
            PeerGroupAdvertisement  obj = group.getPeerGroupAdvertisement();
            if( obj != null)
                desc = obj.getDescription();
        }

        if( desc == null)
            desc = DESCRIPTION;
        return desc;
    }
}
